Skip to content

docs: add Azure Blob service principal authentication#2592

Open
Vaibhav-C-S wants to merge 5 commits into
fluent:masterfrom
Vaibhav-C-S:azure-blob-service-principal-docs
Open

docs: add Azure Blob service principal authentication#2592
Vaibhav-C-S wants to merge 5 commits into
fluent:masterfrom
Vaibhav-C-S:azure-blob-service-principal-docs

Conversation

@Vaibhav-C-S

@Vaibhav-C-S Vaibhav-C-S commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

This PR documents service principal authentication support for the Azure Blob output plugin.

It adds:

  • service_principal as a supported auth_type
  • tenant_id, client_id, and client_secret configuration parameters
  • a service principal authentication example using both YAML and classic config formats

Notes

Service principal authentication requires TLS. The service principal must have permission to write to the target storage account or container, such as the Storage Blob Data Contributor role.

Summary by CodeRabbit

  • Documentation
    • Azure Blob connector docs now include Microsoft Entra ID service principal authentication alongside existing key and SAS options (default remains key).
    • When service principal auth is selected, the guide clarifies required fields: tenant ID, client ID, and client secret.
    • Added a dedicated service principal configuration section with example Fluent Bit setups for both YAML and CONF, including TLS settings.

Signed-off-by: Cheruvu.Sahithee.Vaibhav@ibm.com <Cheruvu.Sahithee.Vaibhav@ibm.com>
@Vaibhav-C-S Vaibhav-C-S requested review from a team and eschabell as code owners June 1, 2026 09:55
@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 680cddfd-af2d-4015-9ff0-291782bec291

📥 Commits

Reviewing files that changed from the base of the PR and between 4a0ea41 and 7687de1.

📒 Files selected for processing (1)
  • pipeline/outputs/azure_blob.md
✅ Files skipped from review due to trivial changes (1)
  • pipeline/outputs/azure_blob.md

📝 Walkthrough

Walkthrough

The Azure Blob connector documentation now includes service_principal as an auth_type, adds client_id, client_secret, and tenant_id as conditionally required fields, and provides a new service principal authentication section with YAML and CONF examples.

Changes

Service Principal Authentication Support

Layer / File(s) Summary
Service principal auth configuration and examples
pipeline/outputs/azure_blob.md
The configuration table adds service_principal support and new client_id, client_secret, and tenant_id rows with conditional mandatory guidance. A new section adds service principal authentication examples in YAML and CONF format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested labels

5.0.7

Suggested reviewers

  • patrick-stephens
  • cosmo0920

Poem

A rabbit found a brighter key,
For Azure docs and symmetry.
With client, secret, tenant too,
The YAML hops, the CONF hops through.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding Azure Blob service principal authentication documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/outputs/azure_blob.md`:
- Line 163: Update the Azure Blob auth paragraph to explicitly require TLS when
using service principal credentials: state that when auth_type is set to
service_principal (and tenant_id, client_id, client_secret are provided) the tls
setting must be on/true to ensure secure communication; modify the sentence that
currently only shows the example so it unambiguously enforces tls=on for service
principal auth.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8036ab68-a151-439d-b8aa-cc6ae073ab6f

📥 Commits

Reviewing files that changed from the base of the PR and between 82ab6af and 9c4fc45.

📒 Files selected for processing (1)
  • pipeline/outputs/azure_blob.md

Comment thread pipeline/outputs/azure_blob.md Outdated
@patrick-stephens

Copy link
Copy Markdown
Contributor

Please resolve the DCO issue as that is a hard requirement for merge.

@eschabell eschabell self-assigned this Jun 1, 2026
@eschabell eschabell added dco DCO failing waiting-on-code-merge waiting-on-review Waiting on a review from mainteners labels Jun 1, 2026
@eschabell

Copy link
Copy Markdown
Collaborator

@Vaibhav-C-S thanks for the docs PR for your matching code changes. As you can see it failed on DCO which is at least one commit not signed. If you open the DCO error with the 3 dots on the right, you can see how to fix this. On top of that you have some other AI suggestions you need to address.

All this needs to happen before we can review this PR.

@eschabell eschabell added the waiting-for-user Waiting for user/contributors feedback or requested changes label Jun 1, 2026
Signed-off-by: Cheruvu.Sahithee.Vaibhav@ibm.com <Cheruvu.Sahithee.Vaibhav@ibm.com>
@Vaibhav-C-S Vaibhav-C-S force-pushed the azure-blob-service-principal-docs branch from 9c4fc45 to 373748e Compare June 1, 2026 15:53
@Vaibhav-C-S

Vaibhav-C-S commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

@eschabell @patrick-stephens I have addressed the dco issue

Cheruvu.Sahithee.Vaibhav@ibm.com and others added 2 commits June 1, 2026 21:31
Signed-off-by: Cheruvu.Sahithee.Vaibhav@ibm.com <Cheruvu.Sahithee.Vaibhav@ibm.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell removed dco DCO failing waiting-for-user Waiting for user/contributors feedback or requested changes labels Jun 27, 2026
@eschabell

Copy link
Copy Markdown
Collaborator

@Vaibhav-C-S resolved the conflicts first, now working on the vale / lint issues and will review after that.

… Vale suggestions

  - Backtick `Entra` in Microsoft Entra ID references
  - Backtick `codec` in compress_blob description

  Applies to fluent#2592

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell

Copy link
Copy Markdown
Collaborator

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eschabell eschabell left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vaibhav-C-S all good now, thanks for the docs PR! Waiting only on code PR merging.

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jun 27, 2026
@Vaibhav-C-S

Copy link
Copy Markdown
Contributor Author

@eschabell Thank you for the help and for the review! I really appreciate it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants